Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include researchdelight hub in compass docs #745

Merged
merged 6 commits into from
May 31, 2023
Merged

Conversation

jmunroe
Copy link
Contributor

@jmunroe jmunroe commented May 29, 2023

This is first step on adding references to the Research Delight hub to the team compass (see #644)

@jmunroe
Copy link
Contributor Author

jmunroe commented May 29, 2023

Other than adding this new page to index.md, is there any other configuration required add this new page?

Is 'References' the right place in the team compass for this content to live?

Copy link
Member

@GeorgianaElena GeorgianaElena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than adding this new page to index.md, is there any other configuration required add this new page?

This should be enough. You can also check how the docs look like after each commit by clicking on the RTD action check at the end of the PR. For example, you can see the new page at https://2i2c-team-compass--745.org.readthedocs.build/reference/researchdelight/

Is 'References' the right place in the team compass for this content to live?

I think I would have probably chosen the "Managed JupyterHub Service" instead of the "Reference" one. I believe although it's used by us and for demo, it's still a managed hub.
Also, I think of the "Reference" section as a place that can be referenced and used to expand and explain part of the other sections.

@jmunroe
Copy link
Contributor Author

jmunroe commented May 30, 2023

Thanks @GeorgianaElena . Good call -- putting it within the "Managed JupyterHub Service" section does make more sense.

jmunroe and others added 2 commits May 31, 2023 11:16
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
@jmunroe jmunroe merged commit 95f0039 into main May 31, 2023
@jmunroe jmunroe deleted the add-researchdelight branch May 31, 2023 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants